<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::Shifter Class Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_shifter.html">Shifter</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_shifter-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle"><div class="title">shark::Shifter Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classshark_1_1_shifter.html" title="Shifter problem.">Shifter</a> problem.  
 <a href="classshark_1_1_shifter.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_shifter_8h_source.html">shark/Unsupervised/RBM/Problems/Shifter.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac21cf17a7ec41054823beaac148ad979" id="r_ac21cf17a7ec41054823beaac148ad979"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shifter.html#ac21cf17a7ec41054823beaac148ad979">Shifter</a> ()</td></tr>
<tr class="separator:ac21cf17a7ec41054823beaac148ad979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf08cd5054280e317072ebaf846ff81e" id="r_aaf08cd5054280e317072ebaf846ff81e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_unlabeled_data.html">UnlabeledData</a>&lt; RealVector &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shifter.html#aaf08cd5054280e317072ebaf846ff81e">data</a> () const</td></tr>
<tr class="memdesc:aaf08cd5054280e317072ebaf846ff81e"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the generated dataset  <br /></td></tr>
<tr class="separator:aaf08cd5054280e317072ebaf846ff81e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b4e0397cefc7876e48a5cb4ce3d2e6e" id="r_a6b4e0397cefc7876e48a5cb4ce3d2e6e"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_shifter.html#a6b4e0397cefc7876e48a5cb4ce3d2e6e">inputDimension</a> () const</td></tr>
<tr class="memdesc:a6b4e0397cefc7876e48a5cb4ce3d2e6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the dimensionality of the data  <br /></td></tr>
<tr class="separator:a6b4e0397cefc7876e48a5cb4ce3d2e6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classshark_1_1_shifter.html" title="Shifter problem.">Shifter</a> problem. </p>

<p class="definition">Definition at line <a class="el" href="_shifter_8h_source.html#l00038">38</a> of file <a class="el" href="_shifter_8h_source.html">Shifter.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac21cf17a7ec41054823beaac148ad979" name="ac21cf17a7ec41054823beaac148ad979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac21cf17a7ec41054823beaac148ad979">&#9670;&#160;</a></span>Shifter()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">shark::Shifter::Shifter </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_shifter_8h_source.html#l00042">42</a> of file <a class="el" href="_shifter_8h_source.html">Shifter.h</a>.</p>

<p class="reference">References <a class="el" href="group__shark__globals.html#ga1a1a4f4249f709e6169a601a9a857fa8">shark::createDataFromRange()</a>, and <a class="el" href="classshark_1_1_shifter.html#aaf08cd5054280e317072ebaf846ff81e">data()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaf08cd5054280e317072ebaf846ff81e" name="aaf08cd5054280e317072ebaf846ff81e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf08cd5054280e317072ebaf846ff81e">&#9670;&#160;</a></span>data()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_unlabeled_data.html">UnlabeledData</a>&lt; RealVector &gt; shark::Shifter::data </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns the generated dataset </p>

<p class="definition">Definition at line <a class="el" href="_shifter_8h_source.html#l00079">79</a> of file <a class="el" href="_shifter_8h_source.html">Shifter.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_shifter.html#ac21cf17a7ec41054823beaac148ad979">Shifter()</a>.</p>

</div>
</div>
<a id="a6b4e0397cefc7876e48a5cb4ce3d2e6e" name="a6b4e0397cefc7876e48a5cb4ce3d2e6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b4e0397cefc7876e48a5cb4ce3d2e6e">&#9670;&#160;</a></span>inputDimension()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t shark::Shifter::inputDimension </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns the dimensionality of the data </p>

<p class="definition">Definition at line <a class="el" href="_shifter_8h_source.html#l00083">83</a> of file <a class="el" href="_shifter_8h_source.html">Shifter.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Unsupervised/RBM/Problems/<a class="el" href="_shifter_8h_source.html">Shifter.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
